/**
 *    Copyright 2009-2018 the original author or authors.
 *
 *    Licensed under the Apache License, Version 2.0 (the "License");
 *    you may not use this file except in compliance with the License.
 *    You may obtain a copy of the License at
 *
 *       http://www.apache.org/licenses/LICENSE-2.0
 *
 *    Unless required by applicable law or agreed to in writing, software
 *    distributed under the License is distributed on an "AS IS" BASIS,
 *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *    See the License for the specific language governing permissions and
 *    limitations under the License.
 */
package com.yinsin.jpabatis.session;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import com.yinsin.jpabatis.mapper.MappedStatement;

/**
 * Specify the behavior when detects an unknown column (or unknown property
 * type) of automatic mapping target.
 *
 * @since 3.4.0
 * @author Kazuki Shimizu
 */
public enum AutoMappingUnknownColumnBehavior {

	/**
	 * Do nothing (Default).
	 */
	NONE {
		@Override
		public void doAction(MappedStatement mappedStatement, String columnName, String property, Class<?> propertyType) {
			// do nothing
		}
	},

	/**
	 * Output warning log. Note: The log level of
	 * {@code 'com.yinsin.jpabatis.session.AutoMappingUnknownColumnBehavior'}
	 * must be set to {@code WARN}.
	 */
	WARNING {
		@Override
		public void doAction(MappedStatement mappedStatement, String columnName, String property, Class<?> propertyType) {
			LogHolder.log.warn(buildMessage(mappedStatement, columnName, property, propertyType));
		}
	},

	/**
	 * Fail mapping. Note: throw {@link SqlSessionException}.
	 */
	FAILING {
		@Override
		public void doAction(MappedStatement mappedStatement, String columnName, String property, Class<?> propertyType) {
			throw new SqlSessionException(buildMessage(mappedStatement, columnName, property, propertyType));
		}
	};

	/**
	 * Perform the action when detects an unknown column (or unknown property
	 * type) of automatic mapping target.
	 * 
	 * @param mappedStatement
	 *            current mapped statement
	 * @param columnName
	 *            column name for mapping target
	 * @param propertyName
	 *            property name for mapping target
	 * @param propertyType
	 *            property type for mapping target (If this argument is not
	 *            null, {@link com.yinsin.jpabatis.type.TypeHandler} for
	 *            property type is not registered)
	 */
	public abstract void doAction(MappedStatement mappedStatement, String columnName, String propertyName, Class<?> propertyType);

	/**
	 * build error message.
	 */
	private static String buildMessage(MappedStatement mappedStatement, String columnName, String property, Class<?> propertyType) {
		return new StringBuilder("Unknown column is detected on '").append(mappedStatement.getId()).append("' auto-mapping. Mapping parameters are ").append("[")
				.append("columnName=").append(columnName).append(",").append("propertyName=").append(property).append(",").append("propertyType=")
				.append(propertyType != null ? propertyType.getName() : null).append("]").toString();
	}

	private static class LogHolder {
		private static final Logger log = LoggerFactory.getLogger(AutoMappingUnknownColumnBehavior.class);
	}

}
